/*
 *  Copyright (C) 2010 glauco
 * 
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 * 
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 * 
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Esta annotation é utilizada em métodos que serão disparados quando ocorrer
 * alguma ação/evento em uma VisualEntity.
 * @author glauco
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface Action {

    /**
     * Tipos de Evento que será disparado o método.
     *
     * @return Array de tipos de EventType validos para o evento ou ação.
     */
    public EventType[] target();

    /**
     * Alias da VisualEntity que possuem o evento ou ação.
     * Não informando os valores será atribuido a todos.
     * Eventos que não forem de VisualEntity não será considerado este filtro.
     *
     * @return Array de alias validas para o evento ou ação.
     */
    public String[] alias() default {};

    /**
     * Propriedades que possão ser utilizadas no momento de disparar um evento.
     * O uso das propriedades está ligado ao tipo de evento {@link EventType}.
     * Os tipos de eventos que utilizam propriedades são:
     *   - GRID_COLUMN_SELECTED
     *   - FIELD_VALIDATION
     *   - FIELD_SYNC
     *   - FIELD_GOT_FOCUS
     *   - FIELD_FOCUS_TRAVEL
     * @return
     */
    public String[] properties() default {};
}
